home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / tncdr104.zip / TNC-DOOR.DOC < prev    next >
Text File  |  1992-04-24  |  13KB  |  267 lines
  1. TNC-DOOR Documentation       April 21, 1992                     V1.04
  2. --- ---- -------------
  3.  
  4. I. REGISTRATION
  5.  
  6. TNC-DOOR is SHAREWARE.  This software is FULLY FUNCTIONAL in every way.
  7. This is not "cripple-ware" or any other such nastiness.  However,
  8. TNC-DOOR is not FREE.  You are permitted to use this software for thirty
  9. days following the day on which you obtained it.  If you decide that
  10. TNC-DOOR is something that you want to continue using, REGISTER the
  11. software by doing ths following:
  12.  
  13. Send a check or money order for TWENTY DOLLARS (U.S.) to:
  14.  
  15.        Vincent Quaresima, K2NE
  16.        30 Marygold Avenue
  17.        Browns Mills, New Jersey 08015
  18.  
  19. This is a one-time LIFETIME registration, which will entitle you to the
  20. use of any future upgrade of the TNC-DOOR.  Upon receipt of your registration
  21. you will get a disk containing the latest version of the TNC-DOOR, along
  22. with any updates to this documentation file.  Please specify DISK SIZE and
  23. FORMAT (360K, 1.2 meg and 1.44 meg, 3.5 inch or 5.25 inch) when you register.
  24.  
  25. THIS SOFTWARE IS NOT FOR USE IN COMMERCIAL INSTALLATIONS.  Such use will be
  26. construed as a VIOLATION of COPYRIGHT.  It is illegal in the United States
  27. to use Amateur Radio for commercial purposes.  Please obey the law!
  28.  
  29.  
  30. II. WHAT YOU SHOULD FIND IN TNCDRxxx.ZIP
  31.  
  32.     a) The "xxx" in the filename corresponds to the version/release
  33.        number.  For example, V1.04 would be TNCDR104.ZIP, etc.
  34.     b) The file TNC-DOOR.EXE is the actual software.
  35.     c) The file TNC-DOOR.DOC is this file you are reading right now.
  36.     d) REGISTER.TNC is a "self-mailer" registration sheet.  Print it
  37.        on your printer in standard 80-col. mode for an "instant mailer."
  38.  
  39.     IF YOU ARE A FIDONET SYSOP and you obtained your TNC-DOOR package
  40.     by File Requesting it, then you may have received a ZIPfile not
  41.     conforming to this "version naming convention."  For example,
  42.     you can always F'req the latest version from Jersey Devil Citadel
  43.     at FIDO 1:266/33 by using the "magic name" TNC-DOOR, in which case
  44.     the FIDO mailer will send you TNC-DOOR.ZIP.  I always make sure that
  45.     TNC-DOOR.ZIP is the most current version, but other sysops may not
  46.     be so careful.
  47.  
  48.  
  49. III. HOW TO SET IT UP
  50.  
  51.     a) Make a directory from which this door will run.  The name of the
  52.        directory is NOT IMPORTANT.
  53.  
  54.     b) Using an ordinary ASCII text editor, create a file called
  55.        HAMUSERS.DAT, which goes in this directory.  The format of the
  56.        file is simple but CRITICAL.
  57.  
  58.        1st line: YOUR CALLSIGN
  59.        2nd line: NAME OF FIRST AUTHORIZED USER
  60.        3rd line: HIS CALLSIGN
  61.        4th line: NAME OF NEXT AUTHORIZED USER
  62.        5th line: HIS CALLSIGN
  63.  
  64.        ETC.
  65.  
  66.        A sample file follows:
  67.  
  68.        k2ne
  69.        vince quaresima
  70.        k2ne-1
  71.        terry rossi
  72.        n2lqh
  73.        brian riley
  74.        ka2bqe
  75.  
  76.        IT IS VERY IMPORTANT THAT THERE BE NOTHING AFTER THE LAST LINE OF THE
  77.        FILE.  THE LAST LINE OF THE FILE MUST BE TERMINATED WITH A CARRIAGE
  78.        RETURN!  As you can see from the example, the names and callsigns are
  79.        NOT "case sensitive."
  80.  
  81.        If your BBS online user's name is in this file then he is an authorized
  82.        user of the TNC-DOOR.  If not, he isn't and he will get a message
  83.        telling him to contact you if he believes he is qualified to use the
  84.        door.  A user whose name is not in this file WILL NOT BE ABLE TO
  85.        ACCESS YOUR TNC!
  86.  
  87.        When an authorized user elects to run the TNC-DOOR, the software will
  88.        check for his name, and match this to his ham call, and will issue a
  89.        MYCALL to your TNC using HIS call.  That way, what he does "on the air"
  90.        will be his responsibility!
  91.  
  92.        When the user ends his packet session, another MYCALL is issued to the
  93.        TNC setting it back to YOUR call (which appears on the first line of
  94.        HAMUSERS.DAT).
  95.  
  96.     c) Use whatever is required to "tell your BBS" about the door.  This varies
  97.        depending on your BBS software, so there is no point in going through
  98.        it here.  Check your BBS documentation for assistance on this point.
  99.        You should be glad to know that the TNC-DOOR will automatically
  100.        recognize DORINFO1.DEF when it finds it IN the "TNC-DOOR" directory.
  101.        Use whatever "batch file magic" is needed to copy the DORINFO file that
  102.        your BBS generates into the TNC-DOOR's directory.  If you are running
  103.        your BBS on something other than COM1 (and hence generating DORINFO2.DEF
  104.        or DORINFO3.DEF, etc.) then simply rename as you move it.
  105.  
  106.        The TNC-DOOR will also recognize (and use) CTDLDOOR.DAT in place of
  107.        a DORINFO#.DEF file if it finds it.  Thus, this software should be
  108.        compatible with RBBS, any other BBS generating a DORINFO#.DEF file,
  109.        Citadel:K2NE, any other BBS generating a Citadel:K2NE-compatible
  110.        CTDLDOOR.DAT file, or any other "door information" file that can be
  111.        modified to LOOK like either of those (yes, there are utilities out
  112.        there that will modify "door information files" to look like them!).
  113.  
  114.  
  115.     d) TNC-DOOR's COMMAND LINE PARAMETERS:
  116.  
  117.        /? will show you the USAGE syntax.  In general, you should set it up
  118.        like this:
  119.  
  120.        TNC-DOOR bbs=1 tnc=2 tncbaud=2400 mycall=yourcall [local]
  121.  
  122.        "bbs=1" tells the door that the BBS is on COM1.  You may change this
  123.        to suit your situation.
  124.  
  125.        "tnc=2" tells the door that the TNC is on COM2.  You can change this.
  126.  
  127.        "tnc-baud=2400" tells the door that your TNC is communicating with
  128.        your computer at 2400 bps.  You may change this.  Allowable settings
  129.        are tnc-baud=300, tnc-baud=1200, tnc-baud=2400 and tnc-baud=9600.
  130.        NOTE THAT THIS HAS NOTHING TO DO WITH THE BAUDRATE YOUR TNC USES
  131.        WHILE TRANSMITTING "ON THE AIR."  Some TNCs are more efficient than
  132.        others (meaning some TNCs are slow clunkers!).  You may have to
  133.        fiddle with your TNCs baud setting (ABAUD is the command on the KAM
  134.        unit that was used for testing this software, yours may differ so
  135.        check your TNC instruction manual).
  136.  
  137.        "local" tells the TNC DOOR that the "user" is on your keyboard
  138.        rather than on the BBS modem.  See section VI below.
  139.  
  140.     e) Grabbing control from your online user
  141.  
  142.        You can terminate a user's TNC DOOR session by pressing CTRL D
  143.        or CTRL K from your system console.  This can be done at ANY TIME
  144.        although common sense would dictate that there are times that
  145.        you should be patient and wait (while your user is in the
  146.        middle of typing a message to a packet BBS or something similar!).
  147.        When you do this, the TNC DOOR will type out a message to your user.
  148.        That message will be whatever you put in the file PRE-EMPT.TXT if you
  149.        create such a file.  Otherwise, the message will be "Your TNC
  150.        session is being terminated by the Sysop."
  151.  
  152.  
  153. IV. OPTIONAL FILES FOR YOUR USER
  154.  
  155. The following files are OPTIONAL.  If they are present they will be used.
  156. If they are not present, the system will chug right along!
  157.  
  158.     a) APPLY.TXT - this is typed to your BBS user if he tries to access
  159.                    the TNC-DOOR and is NOT in your HAMUSERS.DAT file.
  160.     b) TNC-HELP.TXT - this is typed to your user when he issues a CTRL I
  161.                       command.
  162.     c) COMMANDS.TXT - this is typed to your user when he presses ? at any
  163.                       time when your TNC is NOT CONNECTED to another packet
  164.                       station.  Note:  this will create a problem if your TNC
  165.                       does not support DCD and report DCD to your computer.
  166.                       Please get back to me if this creates more hassles than
  167.                       it is worth and I will either remove it or figure out
  168.                       a better way of implementing it.
  169.     d) PRE-EMPT.TXT - this is the file that is typed to the user when you, as
  170.                       Sysop, press CTRL D or CTRL K from your system console
  171.                       keyboard.  If this file is missing, a hard-coded message
  172.                       is sent to the user instead.  See above for more details.
  173.  
  174. In any case, you are left to your own creativity in writing these files.
  175.  
  176. V.  The TNC logging file
  177.  
  178. The TNC-DOOR automatically creates (or appends if it already exists) a file
  179. called TNC.LOG.  This file will automatically record the date, time, username,
  180. and amateur callsign of each user as the user begins his TNC-DOOR session.
  181. This file can be read by pressing "!" while using TNC-DOOR (as long as the
  182. TNC is not in a "connected" state).
  183.  
  184. WARNING:  TNC.LOG will "grow without end" if you do not maintain it.
  185.           I recommend that you set up a weekly event in your main BBS
  186.           scheduler to back it up and then delete it so that TNC-DOOR
  187.           can restart it with a "fresh start."  This can probably be
  188.           "stretched" to more than a week, depending on how active your
  189.           TNC-DOOR becomes (and how large a log file you are willing or
  190.           able to tolerate on your hard disk!).  FCC regulations no longer
  191.           require a "written log of station activity" as in years past.
  192.           This facility is a "sentimental throwback" but some may find
  193.           it useful.
  194.  
  195. VI. The LOCAL mode
  196.  
  197. If you use the "local" parameter when activating TNC-DOOR, the following
  198. happens:
  199.  
  200. 1) The sysop callsign is grabbed from the command line rather than from
  201.    the HAMUSERS.DAT file.
  202.  
  203. 2) The user's callsign is set to the same as the sysop's call.
  204.  
  205. 3) The bbs= parameter is ignored since input will be expected from the
  206.    local console keyboard rather than from a user on a BBS modem.
  207.  
  208. 4) TNC-DOOR will not check for any "door information file" since for
  209.    LOCAL use, none of the information which would be in such a file would
  210.    be needed.  The software "knows" you are on the keyboard, and from the
  211.    setting of the MYCALL= parameter, the software "knows" who you are.
  212.  
  213. 5) You can now directly access your TNC from the keyboard.  However,
  214.    this is only a "dumb terminal" which I have provided for your
  215.    convenience.  It is not intended to be a "full featured" packet terminal
  216.    and probably never will be.  The ONLY purpose for the LOCAL mode is
  217.    so you can make those "quick checks" of your TNC without having to
  218.    load a massive piece of software to do it.
  219.  
  220. 6) The one concession I have made to "feeping creaturism" in the dumb
  221.    terminal is to support capturing a session to a disk file.  To open
  222.    the CAPTURE session, type CTRL B.  You will be prompted to see if you
  223.    want to delete the old capture file.  Answer accordingly.  If you say
  224.    "no" then the CAPTURE session will be appended to the existing file.
  225.    The CAPTURE session filename is TNCBUFF.TXT and is an ASCII file.
  226.    To close the CAPTURE session, type CTRL B once again.  It is a "toggle."
  227.  
  228. 7) To exit TNC-DOOR from the LOCAL mode, press CTRL D or CTRL K.
  229.  
  230. VII. CHATTING with your user
  231.  
  232. At the bottom of the screen (when the user is logged in) you will see
  233. "<ESC> toggles CHAT".  Very simple.  If you want to CHAT with your user,
  234. press ESC and you put TNC-DOOR into a local chat mode.  All TNC activity
  235. will be IGNORED while in chat mode.  To exit from chat mode back to the
  236. TNC (release your user back to the packet session) just press ESC again.
  237.  
  238. This might be handy if you are a sysop that prefers being "polite" and
  239. asking your user to exit the door "in person" rather than CTRL D or
  240. CTRL K to simply send him a message and boot him back to the BBS.
  241.  
  242. Obviously, this would also be handy if you are running TNC-DOOR from
  243. a system that does not support its own chat facility and you simply
  244. want to "talk" to your user.
  245.  
  246. ------------------------------------------------------------------------------
  247.  
  248. And that's about all there is to it!  Please send any suggestions for
  249. enhancements or improvements, along with any "bug reports" to:
  250.  
  251.               Vince Quaresima, K2NE
  252.               30 Marygold Avenue
  253.               Browns Mills, New Jersey 08015
  254.  
  255. And PLEASE don't forget to REGISTER this software!  Only by registering
  256. do you help keep good and inexpensive software coming your way.
  257.  
  258. TNC-DOOR is COPYRIGHT 1992 by Vince Quaresima, K2NE (t/a K2NE Software).
  259. All rights are reserved.  Uploading to electronic databases (free or
  260. commercial) is both PERMITTED and ENCOURAGED.  Swapping or giving the
  261. software away is also permitted.  You may NOT charge for this software
  262. other than a minimal fee to cover the expense of duplicating your disk.
  263.  
  264. SHAREWARE VENDORS:  You are asked to include this software in your collection
  265. of programs.  You are also authorized to sell this software at a price
  266. NOT TO EXCEED FIVE DOLLARS (U.S. funds).  Such a sale does NOT constitute
  267. registration by the end user.